Eclipse Platform
Pre-release 3.0

org.eclipse.team.core.sync
Interface IRemoteResource

All Superinterfaces:
IAdaptable

public interface IRemoteResource
extends IAdaptable

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves. Interface for resources that are not local.

Since:
2.0

Method Summary
 IStorage getBufferedStorage(IProgressMonitor monitor)
          Returns an IStorage that contains (or provides access to) the buffered contents of the remote resource.
 String getComment()
           
 String getContentIdentifier()
           
 InputStream getContents(IProgressMonitor progress)
          Returns a stream over the contents of this remote element.
 String getCreatorDisplayName()
           
 String getName()
          Answers a string that describes the name of the remote resource.
 boolean isContainer()
          Answers if the remote element may have children.
 IRemoteResource[] members(IProgressMonitor progress)
          Answers and array of IRemoteResource elements that are immediate children of this remote resource, in no particular order.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getName

public String getName()
Answers a string that describes the name of the remote resource. The name may be displayed to the user.

Returns:
name of the remote resource.

members

public IRemoteResource[] members(IProgressMonitor progress)
                          throws TeamException
Answers and array of IRemoteResource elements that are immediate children of this remote resource, in no particular order.

Parameters:
progress - a progress monitor to indicate the duration of the operation, or null if progress reporting is not required.
Returns:
array of immediate children of this remote resource.
Throws:
TeamException

getContents

public InputStream getContents(IProgressMonitor progress)
                        throws TeamException
Returns a stream over the contents of this remote element.

Parameters:
progress - a progress monitor to indicate the duration of the operation, or null if progress reporting is not required.
Throws:
TeamException

isContainer

public boolean isContainer()
Answers if the remote element may have children.

Returns:
true if the remote element may have children and false otherwise.

getComment

public String getComment()
                  throws TeamException
Throws:
TeamException

getContentIdentifier

public String getContentIdentifier()
                            throws TeamException
Throws:
TeamException

getCreatorDisplayName

public String getCreatorDisplayName()
                             throws TeamException
Throws:
TeamException

getBufferedStorage

public IStorage getBufferedStorage(IProgressMonitor monitor)
                            throws TeamException
Returns an IStorage that contains (or provides access to) the buffered contents of the remote resource. Returns null if the remote resource does not have contents (i.e. is not a file).

Parameters:
monitor -
Returns:
Throws:
TeamException

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.